|
heartrate13 2.2.1
|
API for configuring and manipulating Heart Rate 13 Click driver. More...
Topics | |
| Heart Rate 13 Registers List | |
| List of registers of Heart Rate 13 Click driver. | |
| Heart Rate 13 Registers Settings | |
| Settings for registers of Heart Rate 13 Click driver. | |
| Heart Rate 13 MikroBUS Map | |
| MikroBUS pin mapping of Heart Rate 13 Click driver. | |
Functions | |
| void | heartrate13_cfg_setup (heartrate13_cfg_t *cfg) |
| Heart Rate 13 configuration object setup function. | |
| err_t | heartrate13_init (heartrate13_t *ctx, heartrate13_cfg_t *cfg) |
| Heart Rate 13 initialization function. | |
| err_t | heartrate13_default_cfg (heartrate13_t *ctx) |
| Heart Rate 13 default configuration function. | |
| err_t | heartrate13_write_register (heartrate13_t *ctx, uint8_t reg, uint16_t data_in) |
| Heart Rate 13 write register function. | |
| err_t | heartrate13_read_register (heartrate13_t *ctx, uint8_t reg, uint16_t *data_out) |
| Heart Rate 13 read register function. | |
| err_t | heartrate13_check_communication (heartrate13_t *ctx) |
| Heart Rate 13 check communication function. | |
| uint8_t | heartrate13_get_io0_pin (heartrate13_t *ctx) |
| Heart Rate 13 get io0 function. | |
| uint8_t | heartrate13_get_io1_pin (heartrate13_t *ctx) |
| Heart Rate 13 get io1 function. | |
| err_t | heartrate13_sw_reset (heartrate13_t *ctx) |
| Heart Rate 13 sw reset function. | |
| err_t | heartrate13_set_mode (heartrate13_t *ctx, uint8_t mode) |
| Heart Rate 13 set mode function. | |
| err_t | heartrate13_set_adc_fsample (heartrate13_t *ctx, uint16_t freq_hz) |
| Heart Rate 13 set adc fsample function. | |
| err_t | heartrate13_clear_status (heartrate13_t *ctx) |
| Heart Rate 13 clear status function. | |
| err_t | heartrate13_wait_data_ready (heartrate13_t *ctx) |
| Heart Rate 13 wait data ready function. | |
| err_t | heartrate13_get_pd_data (heartrate13_t *ctx, heartrate13_pd_data_t *pd_data) |
| Heart Rate 13 get pd data function. | |
API for configuring and manipulating Heart Rate 13 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void heartrate13_cfg_setup | ( | heartrate13_cfg_t * | cfg | ) |
Heart Rate 13 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See heartrate13_cfg_t object definition for detailed explanation. |
| err_t heartrate13_check_communication | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 check communication function.
This function checks the communication by reading and verifying the device ID.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_clear_status | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 clear status function.
This function clears the STATUS register.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_default_cfg | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 default configuration function.
This function executes a default configuration of Heart Rate 13 Click board.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | uint8_t heartrate13_get_io0_pin | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 get io0 function.
This function returns the GPIO0 pin logic state.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| uint8_t heartrate13_get_io1_pin | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 get io1 function.
This function returns the GPIO1 pin logic state.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| err_t heartrate13_get_pd_data | ( | heartrate13_t * | ctx, |
| heartrate13_pd_data_t * | pd_data ) |
Heart Rate 13 get pd data function.
This function waits for the data ready interrupt and then reads data from photodiodes PD1, PD2, and PD3.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [out] | pd_data | : Photodiodes data. See heartrate13_pd_data_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_init | ( | heartrate13_t * | ctx, |
| heartrate13_cfg_t * | cfg ) |
Heart Rate 13 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See heartrate13_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_read_register | ( | heartrate13_t * | ctx, |
| uint8_t | reg, | ||
| uint16_t * | data_out ) |
Heart Rate 13 read register function.
This function reads data word from the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [out] | data_out | : Output read data. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_set_adc_fsample | ( | heartrate13_t * | ctx, |
| uint16_t | freq_hz ) |
Heart Rate 13 set adc fsample function.
This function sets the sample frequency of the device.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [in] | freq_hz | : Sample frequency in Hz (up to 2000 Hz). |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_set_mode | ( | heartrate13_t * | ctx, |
| uint8_t | mode ) |
Heart Rate 13 set mode function.
This function sets the device operating mode.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [in] | mode | :
|
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_sw_reset | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 sw reset function.
This function executes software reset of the device.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_wait_data_ready | ( | heartrate13_t * | ctx | ) |
Heart Rate 13 wait data ready function.
This function waits for the data ready interrupt up to HEARTRATE13_TIMEOUT_MS milliseconds and then clears the STATUS registers.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t heartrate13_write_register | ( | heartrate13_t * | ctx, |
| uint8_t | reg, | ||
| uint16_t | data_in ) |
Heart Rate 13 write register function.
This function writes data word to the selected register by using I2C serial interface.
| [in] | ctx | : Click context object. See heartrate13_t object definition for detailed explanation. |
| [in] | reg | : Register address. |
| [in] | data_in | : Data to be written. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation.